Add some forgotten functions.

Sat Jul 31 17:20:22 2004  Matthias Clasen  <maclas@gmx.de>

	* gtk/gtk-sections.txt: Add some forgotten functions.

Sat Jul 31 17:18:57 2004  Matthias Clasen  <maclas@gmx.de>

	* gtk/framebuffer.sgml:
	* gtk/windows.sgml:
	* gtk/x11.sgml:
	* gtk/running.sgml: Reorganize backend-specific cmdline
	arguments and environment variables, fill the Windows
	sections, add XDG_DATA_HOME, XDG_DATA_DIRS.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index b180d6aa7befd942e333f63d874a8e7add8f45e1..78c861aaee46add0020784e4ba6d3a20f8020ae2 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,21 @@
+Sat Jul 31 17:20:22 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtk-sections.txt: Add some forgotten functions.
+
+Sat Jul 31 17:18:57 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/framebuffer.sgml: 
+       * gtk/windows.sgml: 
+       * gtk/x11.sgml: 
+       * gtk/running.sgml: Reorganize backend-specific cmdline
+       arguments and environment variables, fill the Windows
+       sections, add XDG_DATA_HOME, XDG_DATA_DIRS.
+
+Sat Jul 31 14:06:32 2004  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/running.sgml: We use GTK2_RC_FILES instead of 
+       GTK_RC_FILES...
+
 2004-07-30  Matthias Clasen  <mclasen@redhat.com>
 
        * gtk/gtk-sections.txt: Update to combo box api changes.

diff --git a/docs/reference/gtk/framebuffer.sgml b/docs/reference/gtk/framebuffer.sgml
index da3d0ee42f773559d90b8b100cda3f31229a4e66..6ad1cce2a9ab09875a9c346b86592eeb181d0e1b 100644 (file)
--- a/docs/reference/gtk/framebuffer.sgml
+++ b/docs/reference/gtk/framebuffer.sgml
@@ -92,7 +92,7 @@ virtual console in the current resolution and bit-depth. This can be
 changed by specifying environment variables:
 </para>
 
-<para>
+<para id="fb-envar">
 <programlisting>
 <envar>GDK_VT</envar>:
  unset means open on the current VT.

diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt
index 6bce20a25661724a380076d5e8a00c5696977da3..1cdabc4252394c0d15030a89bf5370f95ab69613 100644 (file)
--- a/docs/reference/gtk/gtk-sections.txt
+++ b/docs/reference/gtk/gtk-sections.txt
@@ -22,6 +22,8 @@ gtk_about_dialog_get_website_label
 gtk_about_dialog_set_website_label
 gtk_about_dialog_get_authors
 gtk_about_dialog_set_authors
+gtk_about_dialog_get_artists
+gtk_about_dialog_set_artists
 gtk_about_dialog_get_documenters
 gtk_about_dialog_set_documenters
 gtk_about_dialog_get_translator_credits

diff --git a/docs/reference/gtk/running.sgml b/docs/reference/gtk/running.sgml
index 40f2374645b8a96ab156d0bb2fa5edc7238598f7..e3624db65dbb7789116c7c1a4d10b34cafcd69cd 100644 (file)
--- a/docs/reference/gtk/running.sgml
+++ b/docs/reference/gtk/running.sgml
@@ -22,7 +22,9 @@ How to run and debug your GTK+ application
 All GTK+ applications support a number of standard commandline
 options. These are removed from <literal>argv</literal> by <link
 linkend="gtk-init">gtk_init()</link>. Modules may parse and remove
-further options.
+further options. The <link linkend="x11-cmdline">X11</link> and
+<link linkend="win32-cmdline">Windows</link> GDK backends parse
+some additional commandline options.
 </para>
 
 <formalpara>
@@ -77,7 +79,7 @@ list them here for completeness nevertheless.
 <title><systemitem>--class <replaceable>class</replaceable></systemitem></title>
 
 <para>
-Sets the program class; see gdk_set_program_class(). 
+Sets the program class; see <link linkend="gdk-set-program-class"><function>gdk_set_program_class</function>()</link>. 
 </para>
 </formalpara>
 
@@ -112,68 +114,6 @@ This option is only available if GTK+ has been configured with
 </para>
 </formalpara>
 
-<formalpara>
-<title><systemitem>--display <replaceable>display</replaceable></systemitem></title>
-
-<para>
-The name of the X display to open instead of the one specified
-in the <envar>DISPLAY</envar> environment variable. 
-This option is only available if GTK+ has been configured with
-<option>--gdk-target=x11</option>.
-</para>
-</formalpara>
-
-<formalpara>
-<title><systemitem>--screen <replaceable>screen_number</replaceable></systemitem></title>
-
-<para>
-  The number of the screen within the default display. This overrides
-  any screen number specified in the display name specified by
-  by he <systemitem>--display</systemitem> command line option or
-  the <envar>DISPLAY</envar> environment variable. If this screen
-  cannot be opened, then GTK+ will fall back to the screen
-  specified in the display name. This option is not useful
-  interactively; the intended purposes is that when a program
-  registers its command line with a <firstterm>session
-  manager</firstterm> for later restarting, it can save the
-  screen it is on, without having to worry if it might be
-  restarted on a different display.
-</para>
-</formalpara>
-
-<formalpara>
-<title><systemitem>--sync</systemitem></title>
-
-<para>
-Makes all X requests synchronously. This is a useful option for 
-debugging, but it will slow down the performance considerably.
-This option is only available if GTK+ has been configured with
-<option>--gdk-target=x11</option>.
-</para>
-</formalpara>
-
-<formalpara>
-<title><systemitem>--gxid-host <replaceable>host</replaceable></systemitem></title>
-
-<para>
-The host to contact the <application>gxid</application> daemon on; overrides 
-the <link linkend="GXID"><envar>GXID_HOST</envar></link> environment variable.
-This option is only available if GTK+ has been configured with
-<option>--gdk-target=x11</option>.
-</para>
-</formalpara>
-
-<formalpara>
-<title><systemitem>--gxid-port <replaceable>port</replaceable></systemitem></title>
-
-<para>
-The port for the connection to <application>gxid</application>; overrides 
-the <link linkend="GXID"><envar>GXID_PORT</envar></link> environment variable.
-This option is only available if GTK+ has been configured with
-<option>--gdk-target=x11</option>.
-</para>
-</formalpara>
-
 </refsect2>
 
 <refsect2>
@@ -182,7 +122,11 @@ This option is only available if GTK+ has been configured with
 <para> 
 GTK+ inspects a number of environment variables in addition to standard
 variables like <envar>LANG</envar>, <envar>PATH</envar>, <envar>HOME</envar> 
-or <envar>DISPLAY</envar>; mostly to determine paths to look for certain files.
+or <envar>DISPLAY</envar>; mostly to determine paths to look for certain 
+files. The <link linkend="x11-envar">X11</link>, 
+<link linkend="win32-envar">Windows</link> and 
+<link linkend="fb-envar">Framebuffer</link> GDK backends use some
+additional environment variables.
 </para>
 
 <formalpara id="GTK-Debug-Options">
@@ -285,7 +229,7 @@ or <envar>DISPLAY</envar>; mostly to determine paths to look for certain files.
 </formalpara>
 
 <formalpara>
-  <title><envar>GTK_RC_FILES</envar></title>
+  <title><envar>GTK2_RC_FILES</envar></title>
   
   <para>
     Specifies a list of RC files to parse instead of the default ones;
@@ -358,26 +302,15 @@ nevertheless.
   </para>
 </formalpara>
 
-<formalpara id="GXID">
-  <title><envar>GXID_HOST</envar> and <envar>GXID_PORT</envar></title>
-
-  <para>
-    The host and port to contact the <application>gxid</application> daemon on. 
-    <application>gxid</application> is only necessary on X servers which 
-    don't support using the pointer and extension devices at once, and is
-    only built if GTK+ is configured with <option>--with-xinput=gxi</option>. 
-    The <application>XFree86</application> X servers don't have this 
-    restriction.
-  </para>
-</formalpara>
-
 <formalpara>
-  <title><envar>GDK_USE_XFT</envar></title>
+  <title><envar>XDG_DATA_HOME</envar>, <envar>XDG_DATA_DIRS</envar></title>
 
   <para>
-    If this variable is set to 1, GTK+ will use the Pango Xft backend instead
-    of the X backend when possible (i.e. when the X server supports the XRender
-    extension and Pango has been built with Xft support). 
+    GTK+ uses these environment variables to locate icon themes
+    and MIME information. For more information, see 
+    <ulink url="http://freedesktop.org/Standards/icon-theme-spec">Icon Theme Specification</ulink>,
+    the <ulink url="http://freedesktop.org/Standards/shared-mime-info-spec">Shared MIME-info Database</ulink> 
+    and the <ulink url="http://freedesktop.org/Standards/basedir-spec">Base Directory Specification</ulink>.
   </para>
 </formalpara>
 

diff --git a/docs/reference/gtk/windows.sgml b/docs/reference/gtk/windows.sgml
index ef909a046bc9a53e681809c0f87377ffb7f15654..756d2a6f7d20640f5925d6d72827bb1be0928e8b 100644 (file)
--- a/docs/reference/gtk/windows.sgml
+++ b/docs/reference/gtk/windows.sgml
@@ -16,8 +16,109 @@ Windows-specific aspects of using GTK+
 <title>Using GTK+ on Windows</title>
 
 <para>
+The Windows port of GTK+ is an implementation of GDK (and therefore GTK+) 
+on top of the Win32 API. 
+</para>
+
+<!-- 
+<refsect2><title>Build requirements</title>
+<para>
+FIXME: explain with-wintab, with-ie55
+</para>
+</refsect2>
+-->
+
+<refsect2 id="win32-cmdline">
+<title>Windows-specific commandline options</title>
+
+<para>
+The Windows GDK backend can be influenced with some
+additional command line arguments.
+</para>
+
+<formalpara>
+<title><systemitem>--sync</systemitem></title>
+
+<para>
+Don't batch GDI requests. This is a useful option for 
+debugging, but it will slow down the performance considerably.
+</para>
+</formalpara>
+
+<formalpara>
+<title><systemitem>--no-wintab</systemitem>, 
+       <systemitem>--ignore-wintab</systemitem></title>
+
+<para>
+Don't use the Wintab API for tablet support. This is the default.
+</para>
+</formalpara>
+
+<formalpara>
+<title><systemitem>--use-wintab</systemitem></title>
+
+<para>
+Use the Wintab API for tablet support, if GTK+ has been compiled 
+with the <option>--with-wintab</option> option.
+</para>
+</formalpara>
+
+<formalpara>
+<title><systemitem>--max-colors <replaceable>number</replaceable></systemitem></title>
+
+<para>
+In 256 color mode, restrict the size of the color palette to 
+the specified number of colors.
+</para>
+</formalpara>
+
+</refsect2>
+
+<refsect2 id="win32-envar">
+<title>Windows-specific environment variables</title>
+
+<para>
+The Win32 GDK backend can be influenced with some
+additional environment variables.
+</para>
+
+<formalpara>
+<title><envar>GDK_IGNORE_WINTAB</envar></title>
+
+<para>
+If this variable is set, GTK+ doesn't use 
+the Wintab API for tablet support. This is the default.
+</para>
+</formalpara>
 
+<formalpara>
+<title><envar>GDK_USE_WINTAB</envar></title>
+
+<para>
+If this variable is set, GTK+ uses the Wintab API for 
+tablet support, if GTK+ has been compiled with the 
+<option>--with-wintab</option> option.
+</para>
+</formalpara>
+
+<formalpara>
+<title><envar>GDK_WIN32_MAX_COLORS</envar></title>
+
+<para>
+Specifies the size of the color palette used
+in 256 color mode.
 </para>
+</formalpara>
+
+<formalpara>
+<title><envar>PRETEND_WIN9X</envar></title>
+
+<para>
+Only use the Windows 9x API.
+</para>
+</formalpara>
+
+</refsect2>
 
 </refsect1>
 

diff --git a/docs/reference/gtk/x11.sgml b/docs/reference/gtk/x11.sgml
index 9054e42a913b651299da4373a863bb6fbf27bf32..7431293a8a46f9ae469f73702c2294b86fa8aef2 100644 (file)
--- a/docs/reference/gtk/x11.sgml
+++ b/docs/reference/gtk/x11.sgml
@@ -27,6 +27,106 @@ see <link linkend="gdk-X-Window-System-Interaction">GDK X Window
 System interaction</link> in the GDK manual.
 </para>
 
+<refsect2 id="x11-cmdline">
+<title>X11-specific commandline options</title>
+
+<para>
+The X backend understands some additional command line 
+arguments.
+</para>
+
+<formalpara>
+<title><systemitem>--display <replaceable>display</replaceable></systemitem></title>
+
+<para>
+The name of the X display to open instead of the one specified
+in the <envar>DISPLAY</envar> environment variable. 
+</para>
+</formalpara>
+
+<formalpara>
+<title><systemitem>--screen <replaceable>screen_number</replaceable></systemitem></title>
+
+<para>
+  The number of the screen within the default display. This overrides
+  any screen number specified in the display name specified by
+  by he <systemitem>--display</systemitem> command line option or
+  the <envar>DISPLAY</envar> environment variable. If this screen
+  cannot be opened, then GTK+ will fall back to the screen
+  specified in the display name. This option is not useful
+  interactively; the intended purposes is that when a program
+  registers its command line with a <firstterm>session
+  manager</firstterm> for later restarting, it can save the
+  screen it is on, without having to worry if it might be
+  restarted on a different display.
+</para>
+</formalpara>
+
+<formalpara>
+<title><systemitem>--sync</systemitem></title>
+
+<para>
+Makes all X requests synchronously. This is a useful option for 
+debugging, but it will slow down the performance considerably.
+</para>
+</formalpara>
+
+<formalpara>
+<title><systemitem>--gxid-host <replaceable>host</replaceable></systemitem></title>
+
+<para>
+The host to contact the <application>gxid</application> daemon on; overrides 
+the <link linkend="GXID"><envar>GXID_HOST</envar></link> environment variable.
+</para>
+</formalpara>
+
+<formalpara>
+<title><systemitem>--gxid-port <replaceable>port</replaceable></systemitem></title>
+
+<para>
+The port for the connection to <application>gxid</application>; overrides 
+the <link linkend="GXID"><envar>GXID_PORT</envar></link> environment variable.
+This option is only available if GTK+ has been configured with
+<option>--gdk-target=x11</option>.
+</para>
+</formalpara>
+
+</refsect2>
+
+<refsect2 id="x11-envar">
+<title>X11-specific environment variables</title>
+
+<para>
+The X backend can be influenced with some
+additional environment variables.
+</para>
+
+<formalpara id="GXID">
+  <title><envar>GXID_HOST</envar>, <envar>GXID_PORT</envar></title>
+
+  <para>
+    The host and port to contact the <application>gxid</application> daemon 
+    on. <application>gxid</application> is only necessary on X servers which 
+    don't support using the pointer and extension devices at once, and is
+    only built if GTK+ is configured with <option>--with-xinput=gxi</option>. 
+    The <application>XFree86</application> and <application>Xorg</application>
+    X servers don't have this 
+    restriction.
+  </para>
+</formalpara>
+
+<formalpara>
+  <title><envar>GDK_USE_XFT</envar></title>
+
+  <para>
+    If this variable is set to 1, GTK+ will use the Pango Xft backend instead
+    of the X backend when possible (i.e. when the X server supports the XRender
+    extension and Pango has been built with Xft support). 
+  </para>
+</formalpara>
+
+</refsect2>
+
 </refsect1>
 
 <refsect1 id="gtk-X11-arch">
@@ -96,6 +196,11 @@ window managers <emphasis>will</emphasis> ignore certain requests from
 time to time, in the interests of good user interface.
 </para>
 
+<!--
+May also want to explain DESKTOP_STARTUP_ID here. 
+http://www.freedesktop.org/Standards/startup-notification-spec
+-->
+
 </refsect2>
 
 </refsect1>